Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Use rfc formatting #25

Closed
wants to merge 3 commits into from
Closed

Conversation

dericed
Copy link
Contributor

@dericed dericed commented Dec 4, 2016

This pull request updates many aspects of the formatting for better handling when transformed through rfc2xml. For instance see the visual issues with https://tools.ietf.org/html/draft-niedermayer-cellar-ffv1-00#section-5.2.

This PR is not intended to produce any semantic change, except for some minor changes in referencing.

@michaelni please confirm that the reference to jpeg2000.org can be
swapped to ISO.15444-1.2016. Preferable to reference a standard rather
than a website.

The jpegls ref is updated to iso14495. The fcd14495p.pdf url was dead anyhow.

@ablwr
Copy link
Contributor

ablwr commented Dec 4, 2016

Very great! 👍

@retokromer
Copy link
Contributor

retokromer commented Dec 4, 2016

The standard is officially called ISO/IEC 15444-1:2016 etc. I would not drop the IEC part.

In the section Assignment operators I would write a := a + 1 etc. instead of a = a + 1 etc.

@dericed
Copy link
Contributor Author

dericed commented Dec 4, 2016

@retokromer I'm following the practice for referencing ISO/IEC standards as done at https://xml2rfc.tools.ietf.org/public/rfc/bibxml2/. In the cases here ISO/IEC standards use anchors that are prefixed with only ISO..

@michaelni
Copy link
Member

michaelni commented Dec 4, 2016

The change for QuantizationTablePerContext adds some \
which show up in the final output, these where not there before, are they intended?

@michaelni
Copy link
Member

the indention of the elements in the 2nd column is inconsistet, for example the br element between the Frame and SliceHeader

@michaelni
Copy link
Member

in SliceHeader() you randomize the indention, sar_den and the following if() are at the same indentio level before a02463a and 1 space different after.

@dericed
Copy link
Contributor Author

dericed commented Dec 4, 2016

@michaelni I couldn't see the character you meant in #25 (comment). But I found an extra | character in there and removed it in fed0e6f.

@dericed
Copy link
Contributor Author

dericed commented Dec 4, 2016

Indentation noted in #25 (comment) and #25 (comment) is fixed in fbe46cc.

@dericed
Copy link
Contributor Author

dericed commented Dec 4, 2016

I think I've updated according to all comments. Please re-review. I can also squash the codeblock commits together if easier.

@michaelni
Copy link
Member

Comment 25 was about a backslash
about combining and spliting commits, please combine bugfixes with commits introducing the bug so no known issues are added while keeping commits seperated. Note this would be much easier if you submit things early as then little rebasing of later commits would be needed

@dericed
Copy link
Contributor Author

dericed commented Dec 4, 2016

Commits are squashed to eliminate introducing/fixing bugs and for readability.

@michaelni
Copy link
Member

Thanks
indention in Parameters() is random,
";" placement at end of lines is random too everywehre
space placement in for() / while() and if() mismatches
space placement in function args and () is inconsistent
space placement around array indexes is inconsistent
Most of this exists priot to the patch some is made worse by it though like the indention in Parameters()

@retokromer
Copy link
Contributor

@dericed It´s not the link itself, but the wording I see that hurts me: the title reads wrong in markdown this way.

@dericed
Copy link
Contributor Author

dericed commented Dec 4, 2016

I updated the Parameters indentation. For the rest which exists prior, let's leave for a later PR.

@dericed
Copy link
Contributor Author

dericed commented Dec 4, 2016

@retokromer can you move the question on iso citation style to cellar.

@michaelni
Copy link
Member

The change to SliceContent() is not correct, same for Line(), the indention in Parameters() also is still not correct

@dericed
Copy link
Contributor Author

dericed commented Dec 5, 2016

I reviewed codeblocks for indentation and order. PR is updated.

@michaelni
Copy link
Member

Pixel() is wrongly indented after te first patch in Line()

@dericed dericed force-pushed the use-rfc-formatting branch 2 times, most recently from e744082 to b17691d Compare December 7, 2016 01:17
@dericed
Copy link
Contributor Author

dericed commented Dec 7, 2016

I fixed Pixel() indentation in Line() and resolved merge conflicts.

@dericed
Copy link
Contributor Author

dericed commented Dec 7, 2016

And rebased to remove the commit on resolving merge conflicts. Should be ready.

@michaelni
Copy link
Member

merged 1 patch, Is it intended that the "left-align" patch skips the Suffix Examples table ?

@dericed
Copy link
Contributor Author

dericed commented Dec 7, 2016

Updated to left-align the Suffix Examples table.

@dericed
Copy link
Contributor Author

dericed commented Dec 8, 2016

@retokromer, regarding #25 (comment), I agree but didn't want to extend the scope of the PR, so I filed it under #27

@dericed
Copy link
Contributor Author

dericed commented Dec 8, 2016

I added a commit to get the references back to the ffv1.pdf since that output doesn't gather them automatically from the xml2rfc process. If of interest, then I can merge that with f6d5db0.

@dericed
Copy link
Contributor Author

dericed commented Dec 13, 2016

@michaelni, anything else needed for the remaining commits?

@michaelni
Copy link
Member

4504e25 make the table rather hard to read in the pdf. The individual terms are hard to see in the flowing text that reaches into the same first column

@dericed
Copy link
Contributor Author

dericed commented Dec 14, 2016

4504e25 is updated to a7cedb0, which is a better compromise between the output of mmark/xml2rfc and pandoc.

@michaelni
Copy link
Member

Is it intended that a130bbc causes litteral "@!" to be shown in the the output (pdf in this case) ?

@dericed
Copy link
Contributor Author

dericed commented Dec 14, 2016

The "@!" is part of mmark's syntax to identify a reference in the RFC output, though this shows as a literal in the PDF output. I suppose we could add a 'sed s/[@!/[/g' to the Makefile before the PDF output is rendered. ?

@michaelni
Copy link
Member

michaelni commented Dec 15, 2016 via email

@retokromer
Copy link
Contributor

+1 for filtering out mmark’s own syntax before rendering the PDF.

@michaelni please confirm that the reference to jpeg2000.org can be
swapped to ISO.15444-1.2016. Preferable to reference a standard rather
than a website.

The jpegls ref is updated to iso14495. The fcd14495p.pdf url was dead anyhow.
compromise between rfc and pandoc outputs
@dericed
Copy link
Contributor Author

dericed commented Dec 15, 2016

The solution suggested in #25 (comment) is implemented in ccd33f2#diff-b67911656ef5d18c4ae36cb6741b7965R15. I also dropped a few commits from the PR that were already cherrypicked.

@retokromer
Copy link
Contributor

LGTM

@michaelni
Copy link
Member

merged

@michaelni michaelni closed this Dec 17, 2016
@JeromeMartinez JeromeMartinez deleted the use-rfc-formatting branch June 23, 2020 19:16
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

4 participants